Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Use compiler default include paths #515

Merged

Conversation

fpelliccioni
Copy link
Collaborator

No description provided.

Copy link
Collaborator

@alandefreitas alandefreitas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is very exciting. As soon as this is merged I'll remove all this logic from the script that generates the boost.url docs: https://github.com/alandefreitas/url/blob/eccc2b85bfecc0d897dca049409cf1b0ddfa2485/doc/generate-files.mjs#L116-L147

@alandefreitas
Copy link
Collaborator

I forgot to mention, but the logic in these lines should be removed so that the tests ensure mrdocs is finding the appropriate include paths and to avoid including these paths twice.

https://github.com/cppalliance/mrdocs/blob/badb9d9e61ece24abf57efb261301eb290aaee2b/.github/workflows/ci.yml#L329C1-L340

@fpelliccioni
Copy link
Collaborator Author

I forgot to mention, but the logic in these lines should be removed so that the tests ensure mrdocs is finding the appropriate include paths and to avoid including these paths twice.

https://github.com/cppalliance/mrdocs/blob/badb9d9e61ece24abf57efb261301eb290aaee2b/.github/workflows/ci.yml#L329C1-L340

Done! removed

Copy link
Collaborator

@alandefreitas alandefreitas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great.

Now that I'm looking at Compiler.h/cpp, this looks kind of weird because it sounds like there are functions able to compile code. Maybe CompilerInfo.h/cpp? I'm just throwing ideas. I'm not sure. It's up to you.

I'm also a little worried about MSVC compiler identification, although this might work anyway as long as there's no "#include <...> search starts here:" in the MSVC output, which is kind of a way of identifying MSVC anyway.

These are just ideas. If you think it's good to go, then it's good to go.

@fpelliccioni
Copy link
Collaborator Author

Looks great.

Now that I'm looking at Compiler.h/cpp, this looks kind of weird because it sounds like there are functions able to compile code. Maybe CompilerInfo.h/cpp? I'm just throwing ideas. I'm not sure. It's up to you.

I'm also a little worried about MSVC compiler identification, although this might work anyway as long as there's no "#include <...> search starts here:" in the MSVC output, which is kind of a way of identifying MSVC anyway.

These are just ideas. If you think it's good to go, then it's good to go.

I removed the MSVC detection (using filename) because it will fail when called with the arguments -v -E -x c++ - and as you said, the output will not contain the pattern we are looking for.

I also renamed Compiler.h/cpp -> CompilerInfo.h/cpp

@alandefreitas
Copy link
Collaborator

Great! So this is good to go, right?

@fpelliccioni
Copy link
Collaborator Author

fpelliccioni commented Dec 19, 2023 via email

@alandefreitas
Copy link
Collaborator

Have you checked the output in the CI artifacts? I don't want to merge two things in a row with problems in the output 😆

@sdkrystian
Copy link
Member

Please squash before you merge!

@fpelliccioni
Copy link
Collaborator Author

Have you checked the output in the CI artifacts? I don't want to merge two things in a row with problems in the output 😆

@alandefreitas @sdkrystian
I'm checking, I don't see any errors in the CI, it's passing Ok.
I understand that you want me to look at the entire output, but it seems strange to me that we are expecting a pattern in the output and it is not marked as an error. I mean maybe we have to modify the CI to make the error more obvious.
What pattern do you look for in the output to see if everything came out OK or not?
I would like to change the CI scripts in another PR, but I need help identifying the patterns.

@fpelliccioni
Copy link
Collaborator Author

@alandefreitas

I checked the output of the "Demos" job in Github Actions and everything seems fine

https://github.com/cppalliance/mrdocs/actions/runs/7262807028/job/19787446683?pr=515#logs

@alandefreitas alandefreitas merged commit 0720a15 into cppalliance:develop Dec 20, 2023
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants